docs(get-started): document Windows bootstrap script option - #3807
Conversation
Signed-off-by: zyang-dev <267119621+zyang-dev@users.noreply.github.com>
📝 WalkthroughWalkthroughAdds a Windows bootstrap-script option to the preparation guide and changes the "Next Step" instructions to branch between following the bootstrap-printed installer command or manually opening WSL and continuing to the Quickstart. ChangesWindows Bootstrap Script Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Comment |
|
🌿 Preview your docs: https://nvidia-preview-pr-3807.docs.buildwithfern.com/nemoclaw |
E2E Advisor RecommendationRequired E2E: None Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
|
ericksoa
left a comment
ericksoa
left a comment
There was a problem hiding this comment.
Approved after adding the same Windows bootstrap guidance to the Fern-rendered MDX page.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/get-started/windows-preparation.mdx (2)
17-17: ⚡ Quick winUse active voice.
"This guide has been tested" is passive. Rewrite in active voice, for example: "NVIDIA has tested this guide on x86-64" or "We have tested this guide on x86-64."
As per coding guidelines: "Active voice required. Flag passive constructions."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/get-started/windows-preparation.mdx` at line 17, Change the passive sentence "This guide has been tested on x86-64." to active voice; replace it with a clear active phrasing such as "NVIDIA has tested this guide on x86-64." or "We have tested this guide on x86-64." so the sentence uses an explicit subject and active verb form.
39-41: ⚡ Quick winVary sentence structure to improve readability.
Three consecutive sentences begin with "If," which creates a repetitive rhythm. Consider combining or rephrasing one of these sentences to improve flow. For example, you could merge lines 39-40 or start line 41 differently: "Complete any first-run prompts from Docker Desktop and return to the PowerShell window."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/get-started/windows-preparation.mdx` around lines 39 - 41, Three consecutive sentences in the paragraph all start with "If," causing repetitive rhythm; reword them to vary sentence structure by either merging the second and third sentences into one conditional clause or by rephrasing the final sentence to an imperative like "Complete any first-run prompts from Docker Desktop and return to the PowerShell window." Locate the paragraph containing the three "If" sentences and update it so one sentence begins differently (e.g., "Complete any first-run prompts...") or combine the WSL reboot/register and Docker reachability checks into a single flowing sentence to improve readability.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/get-started/windows-preparation.mdx`:
- Line 17: Change the passive sentence "This guide has been tested on x86-64."
to active voice; replace it with a clear active phrasing such as "NVIDIA has
tested this guide on x86-64." or "We have tested this guide on x86-64." so the
sentence uses an explicit subject and active verb form.
- Around line 39-41: Three consecutive sentences in the paragraph all start with
"If," causing repetitive rhythm; reword them to vary sentence structure by
either merging the second and third sentences into one conditional clause or by
rephrasing the final sentence to an imperative like "Complete any first-run
prompts from Docker Desktop and return to the PowerShell window." Locate the
paragraph containing the three "If" sentences and update it so one sentence
begins differently (e.g., "Complete any first-run prompts...") or combine the
WSL reboot/register and Docker reachability checks into a single flowing
sentence to improve readability.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 0f39b98e-ad21-4c83-b134-0fc30917b912
📒 Files selected for processing (1)
docs/get-started/windows-preparation.mdx
wscurran
added
platform: windows
3 participants
Summary
Documents the Windows bootstrap script as an optional preparation path before running the NemoClaw Quickstart. The update explains what the script configures, how reboot continuation works, and when users should continue inside Ubuntu.
Changes
Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)Signed-off-by: zyang-dev 267119621+zyang-dev@users.noreply.github.com
Summary by CodeRabbit